/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.dolphinscheduler.plugin.task.flink;

import org.apache.dolphinscheduler.plugin.task.api.TaskExecutionContext;
import org.apache.dolphinscheduler.plugin.task.api.model.Property;
import org.apache.dolphinscheduler.plugin.task.api.model.ResourceInfo;
import org.apache.dolphinscheduler.plugin.task.api.parser.ParamUtils;
import org.apache.dolphinscheduler.plugin.task.api.parser.ParameterUtils;
import org.apache.dolphinscheduler.plugin.task.api.utils.ArgsUtils;

import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;

/**
 * flink args utils
 */
public class FlinkArgsUtils {

  private FlinkArgsUtils() {
    throw new IllegalStateException("Utility class");
  }

  private static final String LOCAL_DEPLOY_MODE = "local";
  private static final String FLINK_VERSION_BEFORE_1_10 = "<1.10";
  private static final String FLINK_VERSION_AFTER_OR_EQUALS_1_12 = ">=1.12";
  private static final String FLINK_VERSION_AFTER_OR_EQUALS_1_13 = ">=1.13";
  /**
   * default flink deploy mode
   */
  public static final FlinkDeployMode DEFAULT_DEPLOY_MODE = FlinkDeployMode.CLUSTER;

  /**
   * build flink run command line
   *
   * @param param flink parameters
   * @return argument list
   */
  public static List<String> buildRunCommandLine(TaskExecutionContext taskExecutionContext, FlinkParameters param) {
    switch (param.getProgramType()) {
      case SQL:
        return buildRunCommandLineForSql(taskExecutionContext, param);
      default:
        return buildRunCommandLineForOthers(taskExecutionContext, param);
    }
  }

  /**
   * build flink cancel command line
   *
   * @param taskExecutionContext
   * @return
   */
  public static List<String> buildCancelCommandLine(TaskExecutionContext taskExecutionContext) {
    List<String> args = new ArrayList<>();
    args.add(FlinkConstants.FLINK_COMMAND);
    args.add(FlinkConstants.FLINK_CANCEL);
    args.add(taskExecutionContext.getAppIds());
    return args;
  }

  /**
   * build flink savepoint command line, the savepoint folder should be set in flink conf
   *
   * @return
   */
  public static List<String> buildSavePointCommandLine(TaskExecutionContext taskExecutionContext) {
    List<String> args = new ArrayList<>();
    args.add(FlinkConstants.FLINK_COMMAND);
    args.add(FlinkConstants.FLINK_SAVEPOINT);
    args.add(taskExecutionContext.getAppIds());
    return args;
  }

  /**
   * build flink run command line for SQL
   *
   * @return argument list
   */
  private static List<String> buildRunCommandLineForSql(TaskExecutionContext taskExecutionContext, FlinkParameters flinkParameters) {
    List<String> args = new ArrayList<>();

    args.add(FlinkConstants.FLINK_SQL_COMMAND);

    // -i
    String initScriptFilePath = FileUtils.getInitScriptFilePath(taskExecutionContext);
    args.add(FlinkConstants.FLINK_SQL_INIT_FILE);
    args.add(initScriptFilePath);

    // -f
    String scriptFilePath = FileUtils.getScriptFilePath(taskExecutionContext);
    args.add(FlinkConstants.FLINK_SQL_SCRIPT_FILE);
    args.add(scriptFilePath);

    String others = flinkParameters.getOthers();
    if (StringUtils.isNotEmpty(others)) {
      args.add(others);
    }
    return args;
  }

  public static List<String> buildInitOptionsForSql(FlinkParameters flinkParameters) {
    List<String> initOptions = new ArrayList<>();

    FlinkDeployMode deployMode = Optional.ofNullable(flinkParameters.getDeployMode()).orElse(FlinkDeployMode.CLUSTER);

    /**
     * Currently flink sql on yarn only supports yarn-per-job mode
     */
    if (FlinkDeployMode.LOCAL == deployMode) {
      // execution.target
      initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_EXECUTION_TARGET, FlinkConstants.FLINK_LOCAL));
    } else {
      // execution.target
      initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_EXECUTION_TARGET, FlinkConstants.FLINK_YARN_PER_JOB));

      // taskmanager.numberOfTaskSlots
      int slot = flinkParameters.getSlot();
      if (slot > 0) {
        initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_TASKMANAGER_NUMBEROFTASKSLOTS, slot));
      }

      // yarn.application.name
      String appName = flinkParameters.getAppName();
      if (StringUtils.isNotEmpty(appName)) {
        initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_YARN_APPLICATION_NAME, ArgsUtils.escape(appName)));
      }

      // jobmanager.memory.process.size
      String jobManagerMemory = flinkParameters.getJobManagerMemory();
      if (StringUtils.isNotEmpty(jobManagerMemory)) {
        initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_JOBMANAGER_MEMORY_PROCESS_SIZE, jobManagerMemory));
      }

      // taskmanager.memory.process.size
      String taskManagerMemory = flinkParameters.getTaskManagerMemory();
      if (StringUtils.isNotEmpty(taskManagerMemory)) {
        initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_TASKMANAGER_MEMORY_PROCESS_SIZE, taskManagerMemory));
      }

      // yarn.application.queue
      String others = flinkParameters.getOthers();
      if (StringUtils.isEmpty(others) || !others.contains(FlinkConstants.FLINK_QUEUE)) {
        String queue = flinkParameters.getQueue();
        if (StringUtils.isNotEmpty(queue)) {
          initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_YARN_APPLICATION_QUEUE, queue));
        }
      }
    }

    // parallelism.default
    int parallelism = flinkParameters.getParallelism();
    if (parallelism > 0) {
      initOptions.add(String.format(FlinkConstants.FLINK_FORMAT_PARALLELISM_DEFAULT, parallelism));
    }

    return initOptions;
  }

  private static List<String> buildRunCommandLineForOthers(TaskExecutionContext taskExecutionContext, FlinkParameters flinkParameters) {
    List<String> args = new ArrayList<>();

    args.add(FlinkConstants.FLINK_COMMAND);
    FlinkDeployMode deployMode = Optional.ofNullable(flinkParameters.getDeployMode()).orElse(DEFAULT_DEPLOY_MODE);
    String flinkVersion = flinkParameters.getFlinkVersion();
    // build run command
    switch (deployMode) {
      case CLUSTER:
        if (FLINK_VERSION_AFTER_OR_EQUALS_1_12.equals(flinkVersion) || FLINK_VERSION_AFTER_OR_EQUALS_1_13.equals(flinkVersion)) {
          args.add(FlinkConstants.FLINK_RUN);  //run
          args.add(FlinkConstants.FLINK_EXECUTION_TARGET);  //-t
          args.add(FlinkConstants.FLINK_YARN_PER_JOB);  //yarn-per-job
        } else {
          args.add(FlinkConstants.FLINK_RUN);  //run
          args.add(FlinkConstants.FLINK_RUN_MODE);  //-m
          args.add(FlinkConstants.FLINK_YARN_CLUSTER);  //yarn-cluster
        }
        break;
      case APPLICATION:
        args.add(FlinkConstants.FLINK_RUN_APPLICATION);  //run-application
        args.add(FlinkConstants.FLINK_EXECUTION_TARGET);  //-t
        args.add(FlinkConstants.FLINK_YARN_APPLICATION);  //yarn-application
        break;
      case LOCAL:
        args.add(FlinkConstants.FLINK_RUN);  //run
        break;
    }

    String others = flinkParameters.getOthers();

    // build args
    switch (deployMode) {
      case CLUSTER:
      case APPLICATION:
        int slot = flinkParameters.getSlot();
        if (slot > 0) {
          args.add(FlinkConstants.FLINK_YARN_SLOT);
          args.add(String.format("%d", slot));   //-ys
        }

        String appName = flinkParameters.getAppName();
        if (StringUtils.isNotEmpty(appName)) { //-ynm
          args.add(FlinkConstants.FLINK_APP_NAME);
          args.add(ArgsUtils.escape(appName));
        }

        // judge flink version, the parameter -yn has removed from flink 1.10
        if (flinkVersion == null || FLINK_VERSION_BEFORE_1_10.equals(flinkVersion)) {
          int taskManager = flinkParameters.getTaskManager();
          if (taskManager > 0) {                        //-yn
            args.add(FlinkConstants.FLINK_TASK_MANAGE);
            args.add(String.format("%d", taskManager));
          }
        }
        String jobManagerMemory = flinkParameters.getJobManagerMemory();
        if (StringUtils.isNotEmpty(jobManagerMemory)) {
          args.add(FlinkConstants.FLINK_JOB_MANAGE_MEM);
          args.add(jobManagerMemory); //-yjm
        }

        String taskManagerMemory = flinkParameters.getTaskManagerMemory();
        if (StringUtils.isNotEmpty(taskManagerMemory)) { // -ytm
          args.add(FlinkConstants.FLINK_TASK_MANAGE_MEM);
          args.add(taskManagerMemory);
        }

        if (StringUtils.isEmpty(others) || !others.contains(FlinkConstants.FLINK_QUEUE)) {
          String queue = flinkParameters.getQueue();
          if (StringUtils.isNotEmpty(queue)) { // -yqu
            args.add(FlinkConstants.FLINK_QUEUE);
            args.add(queue);
          }
        }
        break;
      case LOCAL:
        break;
    }

    int parallelism = flinkParameters.getParallelism();
    if (parallelism > 0) {
      args.add(FlinkConstants.FLINK_PARALLELISM);
      args.add(String.format("%d", parallelism));   // -p
    }

    // If the job is submitted in attached mode, perform a best-effort cluster shutdown when the CLI is terminated abruptly
    // The task status will be synchronized with the cluster job status
    args.add(FlinkConstants.FLINK_SHUTDOWN_ON_ATTACHED_EXIT); // -sae

    // -s -yqu -yat -yD -D
    if (StringUtils.isNotEmpty(others)) {
      args.add(others);
    }

    ProgramType programType = flinkParameters.getProgramType();
    String mainClass = flinkParameters.getMainClass();
    if (programType != null && programType != ProgramType.PYTHON && StringUtils.isNotEmpty(mainClass)) {
      args.add(FlinkConstants.FLINK_MAIN_CLASS);    //-c
      args.add(flinkParameters.getMainClass());          //main class
    }

    ResourceInfo mainJar = flinkParameters.getMainJar();
    if (mainJar != null) {
      // -py
      if (ProgramType.PYTHON == programType) {
        args.add(FlinkConstants.FLINK_PYTHON);
      }
      args.add(mainJar.getRes());
    }

    String mainArgs = flinkParameters.getMainArgs();
    if (StringUtils.isNotEmpty(mainArgs)) {
      Map<String, Property> paramsMap = taskExecutionContext.getPrepareParamsMap();
      args.add(ParameterUtils.convertParameterPlaceholders(mainArgs, ParamUtils.convert(paramsMap)));
    }

    return args;
  }
}
